ReadAxisActualPosition

Reads the current position from an axis using the primary encoder.

Syntax

KsError ReadAxisActualPosition(
     int Index,
     int* Value
);

Parameters

Index: the index of an axis. Indexes are zero based. Aliases affect this parameter.

Value: pointer to the value to receive the current position.

Return value

If the function succeeds, it returns errNoError, otherwise an error code. For more information about the error code, see the KsError list.

Remarks

Used in the cyclic callback to check the actual position of an axis.

Usable EtherCAT states

ecatOP

Example

Copy

int actualPositionRead = 0;
nRet = ReadAxisActualPosition(0, &actualPositionRead);

Requirements